About
Insight Library allows to browse through all available Insight Definition Templates which serve as a basis for creating new Insight Definitions. Each Template consists from:
- summary and short description, description of Triggering and Audience condition and proposed content description
- Suggested classification of Insight Definition goal and categories
- Predefined Triggering and Audience conditions
- Visualizations showing exemplary end user interface with the message
After reviewing Insight Definition Template users can start creating their own Insight Definitions based on selected template. Instead of starting from scratch their Insight Definition draft will be already prepopulated with Triggering and Audience condition rules. User can then adjust all properties of the new Insight Definition and define it's content in the same way as when creating an Insight Definition from scratch.
The classification of goals and categories in Insight Library is just a suggestion and can differ from the Insight Goals and Categories hierarchy defined in the Insight Factory deployment.
The collection of available Insight Definition Templates can grow over time due to:
- new integrations to Insights Factory deployment, for instance new triggering events configured or new Repositories added
- new templates delivered by Meniga Product Experts based on customers demand
- new templates developed internally by the Bank Administrators
If Insight Definition Template requires triggering event that has not been integrated with Insight Factory deployment the Create from template option will be inactive.
Managing Insight Definition Templates
New Insight Definition Templates can be uploaded through the Insight Library page using JSON
files with a following structure:
[
{
"name":"Overdraft risk",
"description":"Notify the customer when there's an upcoming transaction in the next couple of days that could make him go into overdraft and offer him a short-term loan to cover for the potential money shortage",
"shortDescription":"Warn customer from going overdraft",
"contentDescription":"Heads up! There is an upcoming transaction due in {{Upcoming.DaysDue}} days and it seems you might not have enough money for it. Consider taking a short-term loan to cover for it. See loan offer",
"triggerDescription":"Upcoming transaction. Transaction due in less than 7 days. Expected left-to-spend less than €100",
"audienceDescription":"Customers who: don't have saving products, or have no savings, don't have a loan, are eligible to get one, typically have high variance in expenses",
"categoryName":"Cashflow",
"goalName":"Care",
"triggeringEventIdentifier":"UpcomingPaymentDueEvent",
"audienceConditionUi":"{\"tree\":{\"id\":\"a9889899-cdef-4012-b456-7184615d856c\",\"type\":\"group\",\"children1\":{\"b8b9a999-89ab-4cde-b012-3184615d88f9\":{\"type\":\"rule\",\"properties\":{\"field\":\"LoanRepository_IsPersonEligible\",\"operator\":\"equal\",\"value\":[\"true\"],\"valueSrc\":[\"value\"],\"valueError\":[null],\"valueType\":[\"bool\"]}}}},\"parametersDictionary\":[{\"key\":{\"id\":\"b8b9a999-89ab-4cde-b012-3184615d88f9\",\"groupId\":\"a9889899-cdef-4012-b456-7184615d856c\"},\"value\":{\"leftFunc\":{\"func\":\"LoanRepository_IsPersonEligible\",\"args\":{},\"returnType\":\"bool\"}}}]}",
"triggerConditionUi": "{\"tree\": {\"id\": \"bb9a88bb-4567-489a-bcde-f184615949bb\",\"type\": \"group\", \"children1\": { \"ba9bb8bb-0123-4456-b89a-b184615951d7\": { \"type\": \"rule\", \"properties\": { \"field\": \"Amount\", \"operator\": \"greater_or_equal\", \"value\": [\"20\"],\"valueSrc\": [\"value\"],\"valueError\": [null],\"valueType\": [\"Money\"]}}}},\"parametersDictionary\": []}",
"detailsPreviewImage":"/9j/4AAQSkZJRgABAQEA2ADYAAD/2wBDAAYEBQYFBAYGBQYHBwYIChAKCgkJChQODwwQFxQYGBcUFhYaHSUfGhsjHBYWICwgIyYnKSopGR8tMC0oMCUoKSj/2wBDAQcHBwoIChMKChMoGhYaKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCj/wAARCALLAW4DASIAAhEBAxEB/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/8QAHwEAAwEBAQEBAQEBAQAAAAAAAAECAwQFBgcICQoL/8QAtREAAgECBAQDBAcFBAQAAQJ3AAECAxEEBSExBhJBUQdhcRMiMoEIFEKRobHBCSMzUvAVYnLRChYkNOEl8RcYGRomJygpKjU2Nzg5OkNERUZHSElKU1RVVldYWVpjZGVmZ2hpanN0dXZ3eHl6goOEhYaHiImKkpOUlZaXmJmaoqOkpaanqKmqsrO0tba3uLm6wsPExcbHyMnK0tPU1dbX2Nna4uPk5ebn6Onq8vP09fb3+Pn6/9oADAMBAAIRAxEAPwD6pooooAKKKTNAC0Zphao3kCgkkADqTQBNmjdWBd+K9BtGK3Gs6dG46q1ymR+GapN498MKedcsfwkzTsxXR1m6jdXI/wDCf+F/+g3Z/wDfdJ/wn/hj/oN2f/fdFmHMjr91G6uQ/wCE/wDDH/Qbs/8Avuj/AIT/AMMf9Buz/wC+6LMOZHX7qN1ch/wn/hj/AKDdn/33R/wn/hj/AKDdn/33RZhzI6/cKNwrkP8AhP8Awx/0G7P/AL7o/wCE/wDDH/Qbs/8AvuizDmR1+6jdXIf8J/4Y/wCg3Z/990f8J/4Y/wCg3Z/99UWYcyOv3Ubq5D/hP/DH/Qbs/wDvuj/hP/DH/Qbs/wDvuizDmR1+6jdXIf8ACf8Ahj/oN2f/AH3R/wAJ/wCGP+g3Z/8AfdFmHMjr91G6uQ/4T/wx/wBBuz/77o/4T/wx/wBBuz/77osw5kdfuFG6uQ/4T/wx/wBBuz/77o/4T/wx/wBBuz/77osw5kdfuo3VyH/Cf+GP+g3Z/wDfVH/Cf+GP+g3Z/wDfdFmHMjr91G6uQ/4T/wAMf9Buz/77o/4T/wAMf9Buz/77osw5kdfuo3CuQ/4T/wAMf9Buz/77o/4T/wAMf9Buz/77osw5kdfuo3VyH/Cf+GP+g3Z/990f8J/4Y/6Ddn/33RZhzI6/dRurkP8AhP8Awx/0G7P/AL7o/wCE/wDDH/Qbs/8AvuizDmR1+6jdXIf8J/4Y/wCg3Z/990o8f+F/+g3Z/wDfdFmHMjrt1Ga5SPx34Zc8a5YfjKB/OtTT9f0rUGC2Op2Vy392KdXP5A0WYXRsUVEHp4NIY6ikBpaACiiigAoopDQAE1GzYodsVznjTxDF4b8P3WozYZoxtiQn77n7o/x9gaAMz4hePbHwlbiMgXOpSLmO3Bxgf3mPYfqf1Hg2ta/4h8XTM9/dv9nJ4iUlIV+ijr9Tk1Sj+0a7qdxqOpyNK8j7nY/xH09gK2lAUAKAAOABXLicYqL5Ias9vK8leMj7au7Q6Lq/+AY0ehLj95Oc/wCytO/sOL/nq/5CtiivPeNrv7R9HHJMClb2f4v/ADMf+w4v+er/AJCj+w4v+er/AJCtiil9dr/zD/sXA/8APtfj/mY/9hxf89X/ACFH9hxf89X/ACFbFFH12v8AzB/YuB/59r8f8zH/ALDi/wCer/kKP7Di/wCer/kK2KKPrtf+YP7FwP8Az7X4/wCZj/2HF/z1f8hR/YcX/PV/yFbFFH12v/MH9i4H/n2vx/zMf+w4v+er/kKP7Di/56v+QrYoo+u1/wCYP7FwP/Ptfj/mY/8AYcX/AD1f8hR/YcX/AD1f8hWxRR9dr/zB/YuB/wCfa/H/ADMf+w4v+er/AJCj+w4v+er/AJCtiij67X/mD+xcD/z7X4/5mP8A2HF/z1f8hR/YcX/PV/yFbFFH12v/ADB/YuB/59r8f8zH/sOL/nq/5Cj+w4v+er/kK2KKPrtf+YP7FwP/AD7X4/5mP/YcX/PV/wAhR/YcX/PV/wAhWxRR9dr/AMwf2Lgf+fa/H/Mx/wCw4v8Anq/5Cj+w4v8Anq/5Ctiij67X/mD+xcD/AM+1+P8AmY/9hxf89X/IUf2HF/z1f8hWxRR9dr/zB/YuB/59r8f8zH/sOL/nq/5Cj+w4v+er/kK2KKPrtf8AmD+xcD/z7X4/5mP/AGHF/wA9X/IUf2HF/wA9X/IVsU6OJ5N3lozbRuOBnA9aPrlf+YHk2BW9Nfj/AJmL/YcX/PV/yFH9hxf89X/IVuQQS3EmyCNnfGcKM8VY/su9/wCfaT8qaxeIe0iZZTl0XaUEvn/wTm/7Di/56v8AkKil0NhzDMCewYY/Wup/su9PS2kP0FU2BViGBBBwQe1NYzERd2yXk2X1VaMF8m/8ybwv8QvEHha4jgvXe+sRwYZ2yQP9h+o+nI9q+gfC/iKw8R6Wl9pku+NuGVuGjburDsa+c7iCO4iMcq5U/pTPBmv3PgrxMkpZmspCEuEHR4/XHqOo/Ed69LDYlYhWekj5jNMqll7U4u8H969T6qVs08GqVrcJPCksTh43UMrA5BB6EVbU1ueWPooooAKaxp1RyGgCGVq8N/aD1JmuNK01W+QK1w6+pPyr/Jvzr2ydsV89fG+TzPHFqp6Laxj/AMfc/wBaqO9yZK+ncyLOEW9tHGP4Rz9e9TUUV81KTk22fqdOCpxUI7LQ63TGsX0nRJtQtYfKW+khkaOL5nUIhG7HLcnkVJrFtZvpmn3V4YJ5HuJYy2mw+VvQKCMAqASCeuOhxnIrlYby5hWJYZ5UET+agViNrcfMPQ8D8qnn1jUZ7xLqa9uHuIxtSQucqPQenU1t7WNrNHC8JPnUovv19fLz19Dp9Mhiil8PWMdhb3FrqKBriR4gzsS5VsP1XYB2x6mq2kmK3sbk3lpZnSU82MTNEDLcvghQjHkYODkYAHXk1z9vqt/bWklrb3lxFbyZ3Rq5CnPXj3qW313VLa1W2g1C6jgUELGshCgHrxQqsdCZYSo72a18356...",
"listPreviewImage":"/9j/4AAQSkZJRgABAQEA2ADYAAD/2wBDAAYEBQYFBAYGBQYHBwYIChAKCgkJChQODwwQFxQYGBcUFhYaHSUfGhsjHBYWICwgIyYnKSopGR8tMC0oMCUoKSj/2wBDAQcHBwoIChMKChMoGhYaKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCj/wAARCALLAW4DASIAAhEBAxEB/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/8QAHwEAAwEBAQEBAQEBAQAAAAAAAAECAwQFBgcICQoL/8QAtREAAgECBAQDBAcFBAQAAQJ3AAECAxEEBSExBhJBUQdhcRMiMoEIFEKRobHBCSMzUvAVYnLRChYkNOEl8RcYGRomJygpKjU2Nzg5OkNERUZHSElKU1RVVldYWVpjZGVmZ2hpanN0dXZ3eHl6goOEhYaHiImKkpOUlZaXmJmaoqOkpaanqKmqsrO0tba3uLm6wsPExcbHyMnK0tPU1dbX2Nna4uPk5ebn6Onq8vP09fb3+Pn6/9oADAMBAAIRAxEAPwD6pooooAKKKTNAC0Zphao3kCgkkADqTQBNmjdWBd+K9BtGK3Gs6dG46q1ymR+GapN498MKedcsfwkzTsxXR1m6jdXI/wDCf+F/+g3Z/wDfdJ/wn/hj/oN2f/fdFmHMjr91G6uQ/wCE/wDDH/Qbs/8Avuj/AIT/AMMf9Buz/wC+6LMOZHX7qN1ch/wn/hj/AKDdn/33R/wn/hj/AKDdn/33RZhzI6/cKNwrkP8AhP8Awx/0G7P/AL7o/wCE/wDDH/Qbs/8AvuizDmR1+6jdXIf8J/4Y/wCg3Z/990f8J/4Y/wCg3Z/99UWYcyOv3Ubq5D/hP/DH/Qbs/wDvuj/hP/DH/Qbs/wDvuizDmR1+6jdXIf8ACf8Ahj/oN2f/AH3R/wAJ/wCGP+g3Z/8AfdFmHMjr91G6uQ/4T/wx/wBBuz/77o/4T/wx/wBBuz/77osw5kdfuFG6uQ/4T/wx/wBBuz/77o/4T/wx/wBBuz/77osw5kdfuo3VyH/Cf+GP+g3Z/wDfVH/Cf+GP+g3Z/wDfdFmHMjr91G6uQ/4T/wAMf9Buz/77o/4T/wAMf9Buz/77osw5kdfuo3CuQ/4T/wAMf9Buz/77o/4T/wAMf9Buz/77osw5kdfuo3VyH/Cf+GP+g3Z/990f8J/4Y/6Ddn/33RZhzI6/dRurkP8AhP8Awx/0G7P/AL7o/wCE/wDDH/Qbs/8AvuizDmR1+6jdXIf8J/4Y/wCg3Z/990o8f+F/+g3Z/wDfdFmHMjrt1Ga5SPx34Zc8a5YfjKB/OtTT9f0rUGC2Op2Vy392KdXP5A0WYXRsUVEHp4NIY6ikBpaACiiigAoopDQAE1GzYodsVznjTxDF4b8P3WozYZoxtiQn77n7o/x9gaAMz4hePbHwlbiMgXOpSLmO3Bxgf3mPYfqf1Hg2ta/4h8XTM9/dv9nJ4iUlIV+ijr9Tk1Sj+0a7qdxqOpyNK8j7nY/xH09gK2lAUAKAAOABXLicYqL5Ias9vK8leMj7au7Q6Lq/+AY0ehLj95Oc/wCytO/sOL/nq/5CtiivPeNrv7R9HHJMClb2f4v/ADMf+w4v+er/AJCj+w4v+er/AJCtiil9dr/zD/sXA/8APtfj/mY/9hxf89X/ACFH9hxf89X/ACFbFFH12v8AzB/YuB/59r8f8zH/ALDi/wCer/kKP7Di/wCer/kK2KKPrtf+YP7FwP8Az7X4/wCZj/2HF/z1f8hR/YcX/PV/yFbFFH12v/MH9i4H/n2vx/zMf+w4v+er/kKP7Di/56v+QrYoo+u1/wCYP7FwP/Ptfj/mY/8AYcX/AD1f8hR/YcX/AD1f8hWxRR9dr/zB/YuB/wCfa/H/ADMf+w4v+er/AJCj+w4v+er/AJCtiij67X/mD+xcD/z7X4/5mP8A2HF/z1f8hR/YcX/PV/yFbFFH12v/ADB/YuB/59r8f8zH/sOL/nq/5Cj+w4v+er/kK2KKPrtf+YP7FwP/AD7X4/5mP/YcX/PV/wAhR/YcX/PV/wAhWxRR9dr/AMwf2Lgf+fa/H/Mx/wCw4v8Anq/5Cj+w4v8Anq/5Ctiij67X/mD+xcD/AM+1+P8AmY/9hxf89X/IUf2HF/z1f8hWxRR9dr/zB/YuB/59r8f8zH/sOL/nq/5Cj+w4v+er/kK2KKPrtf8AmD+xcD/z7X4/5mP/AGHF/wA9X/IUf2HF/wA9X/IVsU6OJ5N3lozbRuOBnA9aPrlf+YHk2BW9Nfj/AJmL/YcX/PV/yFH9hxf89X/IVuQQS3EmyCNnfGcKM8VY/su9/wCfaT8qaxeIe0iZZTl0XaUEvn/wTm/7Di/56v8AkKil0NhzDMCewYY/Wup/su9PS2kP0FU2BViGBBBwQe1NYzERd2yXk2X1VaMF8m/8ybwv8QvEHha4jgvXe+sRwYZ2yQP9h+o+nI9q+gfC/iKw8R6Wl9pku+NuGVuGjburDsa+c7iCO4iMcq5U/pTPBmv3PgrxMkpZmspCEuEHR4/XHqOo/Ed69LDYlYhWekj5jNMqll7U4u8H969T6qVs08GqVrcJPCksTh43UMrA5BB6EVbU1ueWPooooAKaxp1RyGgCGVq8N/aD1JmuNK01W+QK1w6+pPyr/Jvzr2ydsV89fG+TzPHFqp6Laxj/AMfc/wBaqO9yZK+ncyLOEW9tHGP4Rz9e9TUUV81KTk22fqdOCpxUI7LQ63TGsX0nRJtQtYfKW+khkaOL5nUIhG7HLcnkVJrFtZvpmn3V4YJ5HuJYy2mw+VvQKCMAqASCeuOhxnIrlYby5hWJYZ5UET+agViNrcfMPQ8D8qnn1jUZ7xLqa9uHuIxtSQucqPQenU1t7WNrNHC8JPnUovv19fLz19Dp9Mhiil8PWMdhb3FrqKBriR4gzsS5VsP1XYB2x6mq2kmK3sbk3lpZnSU82MTNEDLcvghQjHkYODkYAHXk1z9vqt/bWklrb3lxFbyZ3Rq5CnPXj3qW313VLa1W2g1C6jgUELGshCgHrxQqsdCZYSo72a18356..."
},
...
]
Attribute | Type | Is required | Description |
---|---|---|---|
name | nvarchar(128) | yes | Name of the insight definition template |
description | nvarchar(512) | yes | Description of the insight definition template |
shortDescription | nvarchar(256) | yes | Short description of the insight definition template |
contentDescription | nvarchar(512) | yes | Description of the insight definition template content |
triggerDescription | nvarchar(512) | yes | Description of the insight definition triggering condition |
audienceDescription | nvarchar(512) | yes | Description of the insight definition template audience condition |
triggerConditionUi | nvarchar(max) | no | UI representation of Trigger condition filters |
audienceConditionUi | nvarchar(max) | yes | UI representation of Audience condition filters |
triggeringEventIdentifier | nvarchar(512) | no | Event type identifier used for determining event type which the insight definition template is related to |
detailsPreviewImage | nvarchar(max) | yes | Base64 encoded preview image of the insight definition template to be shown on the template's details page |
listPreviewImage | nvarchar(max) | yes | Base64 encoded preview image of the insight definition template to be shown on a templates list. Images displayed on the list have a fixed height of 200px and will be scaled up or down to fit this value. |
categoryName | nvarchar(128) | yes | Proposed category name for the Insight Definition |
goalName | nvarchar(128) | yes | Proposed goal name for the Insight Definition |
If any template in the uploaded file is invalid (for instance due to incorrect structure) then none Insight Definition Template will be uploaded.
Data model
Uploaded Insight Definition Templates end up in the [insightsfactory].insight_definition_templates
database table.
Attribute | Type | Is required | Description |
---|---|---|---|
id | bigint | yes | Numerical identifier |
name | nvarchar(128) | yes | Name of the insight definition template |
description | nvarchar(512) | yes | Description of the insight definition template |
short_description | nvarchar(256) | yes | Short description of the insight definition template |
content_description | nvarchar(512) | yes | Description of the insight definition template content |
trigger_description | nvarchar(512) | yes | Description of the insight definition triggering condition |
audience_description | nvarchar(512) | yes | Description of the insight definition template audience condition |
trigger_condition_ui | nvarchar(max) | no | UI representation of Trigger condition filters |
audience_condition_ui | nvarchar(max) | yes | UI representation of Audience condition filters |
triggering_event_identifier | nvarchar(512) | no | Event type identifier used for determining event type which the insight definition template is related to |
details_preview_image | nvarchar(max) | yes | Base64 encoded preview image of the insight definition template to be shown on the template's details page |
list_preview_image | nvarchar(max) | yes | Base64 encoded preview image of the insight definition template to be shown on the page with list of templates |
category_name | nvarchar(128) | yes | Proposed category name for the Insight Definition |
goal_name | nvarchar(128) | yes | Proposed goal name for the Insight Definition |
version | timestamp | yes | Row version used for optimistic concurrency |
created_utc | datetime2(7) | yes | Audit column - the date of entity creation (utc) |
modified_utc | datetime2(7) | no | Audit column - the date of entity last modification (utc) |
created_by | nvarchar(256) | yes | Audit column - the creator of entity |
modified_by | nvarchar(256) | no | Audit column - the author of last update performed on entity |
is_deleted | bit | yes | True if the insight definition template is deleted |
Modification
Modification of Insight Definition Templates is not allowed. No longer needed templates can be soft deleted from the Insight Library using the following API request:
curl -X 'DELETE' \
'admin/insights/v1/templates?ids=1&ids=2&ids=99' \
-H 'Authorization: Bearer {token}' \
-H 'accept: */*'
Where ids
are the numerical identifiers of Insight Definition Templates we wish to remove.